Skip to content

[Doc] Consolidate relevant wiki content#45732

Draft
pvaneck wants to merge 1 commit intoAzure:mainfrom
pvaneck:wiki-migration
Draft

[Doc] Consolidate relevant wiki content#45732
pvaneck wants to merge 1 commit intoAzure:mainfrom
pvaneck:wiki-migration

Conversation

@pvaneck
Copy link
Member

@pvaneck pvaneck commented Mar 17, 2026

Part of: #45672

Pages not directly migrated

Going through the wiki, I've decided not to directly port the following pages:

  • How to fix CI
    • Reason: This only had two tips about CI failures regarding cspell and pylint/mypy/pyright without outdated exlusion info.
    • Added CSpell section in eng_sys_checks.md. Info about other checks already available in other docs.
  • Generate docs for sdk with sphinx
    • Reason: This was a short guide about using Sphinx to generate docs that entailed downloading a mystery zip file. We want to encourage using azpysdk tool for generating documentation.
    • Potential Action Item: Maybe add a new fleshed out documentation generation guide, but running azpysdk sphinx . and checking the output seems straightforward enough that a separate guide may not be necessary.
  • Telemetry with Azure SDKs
    • Reason: This page was primarily about using OpenCensus for telemetry, which is deprecated in favor of OpenTelemetry.
    • Potential Action Item: Add a telemetry documentation generation guide that focuses on using OpenTelemetry with Azure SDKs.
  • [TestProxy]-Run-test-with-testproxy-for-mgmt-SDK.md
    • Reason: Deprecated workflow and superseded content
  • Management-Plane-Codegen-Quick-Start-for-Test.md
    • Reason: Duplicates content in main tests.md and mgmt/tests.md files.
      Potential Action Item: Consider adding a general testing quickstart guide.
  • Legacy-tests.md
    • Reason: This page contained documentation about legacy tests that are no longer relevant.
  • Direct-access-to-models-is-deprecated.md
    • Reason: This document described a deprecated pattern making this guidance obsolete. Not worth adding.
  • Generate-Python-Mgmt-SDK.md
    • Reason: This page described the Swagger generation workflow which is already covered in the existing generation.md file. Swagger generation is also deprecated.
  • Dataplane-Codegen-Quick-Start-For-Swagger.md
    • Reason: This page described the Swagger generation workflow which is deprecated and not worth preserving.
  • Dataplane-Codegen-Quick-Start-with-tools.md
    • Reason: This tooling is likely obsolete and hasn't been updated in a long time.
  • Generate-Swagger-and-TypeSpec-in-Package.md
    • Reason: This page described a hybrid generation approach (swagger + TypeSpec). Since swagger generation is deprecated, this hybrid approach is not worth preserving as a standalone doc.
  • Dataplane-Codegen-Quick-Start-for-Test.md
    • Reason: Massively duplicates tests.md
    • Potential Action Item: Consider adding a general testing quickstart guide.

Pages migrated

  • Azure-SDKs-Python-version-support-policy.md
    • Versions policy that is referenced in several places across the repo
  • Generate-Python-Mgmt-SDK-from-Typespec.md
    • Management plane TypeSpec generation information. - merged with doc/dev/mgmt/generation.md
  • Dataplane-Codegen-Quick-Start.md
    • Dataplane codegen quickstart guide (TypeSpec). - Created doc/dev/dataplane_generation.md
  • What-to-do-after-generating-the-SDK-code-with-codegen.md
    • Merged with doc/dev/dataplane_generation.md.
  • Common-issues-about-Python-SDK.md - Some unique content about common issues and troubleshooting. - Created doc/dev/common_issues.md
    • Removed two sections:
      • "Download private package from PR of Azure/azure-rest-api-specs repo" — This section consisted almost entirely of screenshots walking through Azure DevOps CI UI navigation. Screenshots are fragile and break when the CI UI changes, making maintenance costly. The workflow itself is niche (only relevant to service teams downloading artifacts from spec repo PRs) and not a common SDK issue or FAQ.
      • "Renaming parameters nested in anonymous models" — This documented a very specific TypeSpec edge case involving @@clientName on parameters inside anonymous models. It reads more like a one-off troubleshooting note for a single GitHub issue than general guidance. This type of TypeSpec-specific workaround belongs in the TypeSpec documentation or in a GitHub discussion, not in a general Python SDK FAQ page.

Signed-off-by: Paul Van Eck <paulvaneck@microsoft.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant